Improve polygon and line documentation. #824

manthey · 2018-05-23T18:00:11Z

This should make it clearer what the position, line, and polygon accessors do. It also explicitly defines a polygon data type.

@Class

This change is the result of running ``` sed -i $'s/^ \* @Class / * @Class\\n * @alias /g' `git grep -l '^ \* @Class '` ```

aashish24 · 2018-05-28T20:20:20Z

src/lineFeature.js

+   * @param {object|function} [val] If specified, use this for the line
+   *    accessor and return the feature.  If not specified, return the current
+   *    line.  If a function, this is passed `(dataElement, dataIndex)` and
+   *    returns an array of vertex elements.


returns or return? above the sentences read return.

Is there a possibility that this sentence could be improved further (and the ones below)?

aashish24

thanks for consideration.

@Class

Fix any jsdoc @Class <name> to be @Class, @alias <name>

manthey added 2 commits May 23, 2018 13:57

Improve polygon and line documentation.

1b60422

This should make it clearer what the position, line, and polygon accessors do. It also explicitly defines a polygon data type.

Fix any jsdoc @Class <name> to be @Class, @alias <name>

eaf7bb2

This change is the result of running ``` sed -i $'s/^ \* @Class / * @Class\\n * @alias /g' `git grep -l '^ \* @Class '` ```

aashish24 reviewed May 28, 2018

View reviewed changes

Reword some comments.

d715877

manthey force-pushed the polygon-and-line-docs branch from 521d317 to d715877 Compare May 29, 2018 13:14

aashish24 approved these changes May 29, 2018

View reviewed changes

manthey added 2 commits May 29, 2018 15:05

Merge branch 'master' into polygon-and-line-docs

ec2ef32

Merge pull request #825 from OpenGeoscience/fix-class-alias-docs

4107f58

Fix any jsdoc @Class <name> to be @Class, @alias <name>

manthey merged commit 5a4006f into master May 29, 2018

manthey deleted the polygon-and-line-docs branch May 29, 2018 19:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve polygon and line documentation. #824

Improve polygon and line documentation. #824

manthey commented May 23, 2018

aashish24 May 28, 2018

aashish24 May 28, 2018

aashish24 left a comment

Improve polygon and line documentation. #824

Improve polygon and line documentation. #824

Conversation

manthey commented May 23, 2018

aashish24 May 28, 2018

Choose a reason for hiding this comment

aashish24 May 28, 2018

Choose a reason for hiding this comment

aashish24 left a comment

Choose a reason for hiding this comment